home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / editor / us20doc.zip / SPELL.MSS < prev    next >
Text File  |  1992-07-04  |  8KB  |  191 lines

  1. @begin(verbatim)
  2.  
  3.  
  4.         @b(Using MicroSPELL)
  5.  
  6.         version 2.0 - released July 4, 1992
  7.  
  8.         @i(Spelling Checker and Corrector)
  9.         @i(written by Daniel Lawrence)
  10.  
  11.         (C)Copyright 1987, 1992 by Daniel M. Lawrence
  12.  
  13.         MicroSPELL 2.0 can be copied and distributed freely for any
  14.         non-commercial purposes. Commercial users may use MicroSPELL
  15.         2.0 inhouse. Shareware distributors may redistribute
  16.         MicroSPELL 2.0 for media costs only. MicroSPELL 2.0 can only
  17.         be incorporated into commercial software or resold with the
  18.         permission of the author.
  19.  
  20. @end(verbatim)
  21.  
  22.  
  23.  
  24. @flushleft(@b(Introduction))
  25.  
  26.     MicroSPELL 2.0 is a compact, efficient, fast spelling checker
  27. for use both as a stand alone program, and with MicroEMACS v3.11 and
  28. above on many different computers.  Currently supported computers
  29. include IBM-PCs under MSDOS and OS/2, ATARI ST, Amigas, and UNIX
  30. machines of various types. MicroSPELL is supplied both as IBM-PC
  31. executables, and as C source code suitable for compilation by most C
  32. compilers.
  33.  
  34.     MicroSPELL contains tools for marking misspellings, scanning for
  35. replacements, single word suggestions, and user and main dictionary
  36. maintenance. MicroSPELL is normally used in conjunction with MicroEMACS
  37. 3.11 in order to scan text files, stepping through misspellings and
  38. making suggestions and corrections.
  39.  
  40. @flushleft(@b(Spell Correction))
  41.  
  42.     The SPELL program is responsible for scanning files and marking
  43. suspect words. The SCAN.CMD macro is used by MicroEMACS to then step
  44. through suspect words, making suggestions, and allowing corrections.
  45. This combination can be called in two ways. If you have a text file in
  46. MicroEMACS, call up the Word processing page (<F8>-W) and use the
  47. SHIFT-<F4> key to activate a spell scan on the current buffer. Outside
  48. of MicroEMACS, use the SPELL command as follows:
  49.  
  50. @begin(verbatim)
  51.     spell {<options>} <file> {<file>.........<file>}
  52.  
  53. The currently available options are:
  54.  
  55. -d        debugging mode
  56. -e        use MicroEMACS to scan errors
  57. -u <fname>    use a user word list 
  58. -w        output a word list instead of a location list
  59. @end(verbatim)
  60.  
  61. @Flushleft(@b<Example>)
  62.  
  63.     Let's assume that you want to spell check a text file called
  64. text.txt which is on the @b{B} drive of your machine.  To invoke spell
  65. type:
  66.  
  67.     @b[spell -e b:text.txt]
  68.  
  69.     Be patient.  It will take SPELL a short while to complete its
  70. setup procedure.  If would like to know more about what SPELL is doing
  71. at this point, you can set the debugging switch (@b[-d]} when you first
  72. invoke the program.  SPELL will then give you detailed information about
  73. what it is doing.
  74.  
  75.     When SPELL has finished checking your file against its internal
  76. dictionary, it will give you a brief report of how many suspect words it
  77. found, and then, since we used the @b(-e) switch, it will invoke
  78. MicroEMACS in order to scan through the suspect words.  You will see the
  79. screen divided into three windows. The top window is the SPELL functions
  80. and status window. The middle window will display suggested replacements
  81. during the spell scan. The bottom most window will contain a portion of
  82. the document being scanned, so that you can see the suspect words in
  83. context.
  84.  
  85.     There are a number of elements in the uppermost window that you
  86. need to be aware of.  On the top line, the "File" field lists which file
  87. the scan is currently on.  This is useful when many different files are
  88. spell checked together in one run (many file names can be put on the
  89. command line at once).  The first number is the current file, and the
  90. second number is the total number of files.
  91.  
  92.     The second field on the top line is the "Word" filed. This
  93. describes the current suspect word and the total number of suspect words
  94. in the current file.  This will give you an idea of how far throughout the
  95. file you have progressed during the scan.
  96.  
  97.     One at a time, each suspect word in the file is presented to you
  98. for you to decide on its disposition.  The suspect word is displayed,
  99. and the question "Option:" appears in the Dialog Window.  The options
  100. you have include:
  101.  
  102. @begin(verbatim)
  103. (S)kip        Skip this word, leaving it alone, and go on to the next.
  104.  
  105. (I)gnore    Ignore this word and all other occurences of this word
  106.         during this scan.
  107.  
  108. (C)hange    Change this word.  You will be asked to type a
  109.         replacement word.  This word will replace the original
  110.         and MicroSPELL will remember the replacement.
  111.  
  112. (D)efault    If you have already replaced an identical occurrence
  113.    replace    of this suspect word, MicroSPELL will present the last
  114.         replacement as a "Default Replacement".  Picking this
  115.         option automatically replaces the suspect word with
  116.         this default word.
  117.  
  118. (G)lobal    When you first encounter a suspect word, if you wish
  119.     change    it to be replaced in the entire document, use this
  120.         option. You will be prompted for the replacement word.
  121.  
  122. (A)dd word    To a user dictionary.  This word will then be remembered
  123.         for the remainder of the current scan, and also for all
  124.         future scans when that user dictionary is invoked.
  125.  
  126. (U)pper case    Add a word to a user dictionary in its current case.
  127.         This is good for names, proper nouns and acronyms.
  128.  
  129. (Q)uit        Finish the current scan, saving the file with the
  130.         already completed changes. MicroSPELL will ask if you
  131.         want to save the results of the scan, or discard them.
  132. @end(verbatim)
  133.  
  134.     Also, in the center window may be a list of possible replacement
  135. words. An arrow to the right of one of these words indicated which word
  136. is currently selected. The cursor keys can be used to move the arrow
  137. through the list of words. The <RETURN> key causes the suspect word to
  138. be replaced with the currently selected replacement word.
  139.  
  140. @flushleft(@b(Using the Mouse))
  141.  
  142.     During the spell check run, the mouse can be clicked on any
  143. option to use that option. Clicking on one of the replacement words
  144. causes that word to replace the suspect word.
  145.  
  146. @flushleft(@b(Merging a user word list into the Main Dictionary))
  147.  
  148.     While normally you would probably keep your user word lists
  149. separate from the main dictionary, if you discover a common english word
  150. or words which appear missing from the main dictionary, the DMERGE
  151. program is used.
  152.  
  153.     @b(dmerge <output dictionary> <user file> {<user file>..})
  154.  
  155.     One or more user word lists will be merged with the currently
  156. active dictionary resulting in a new word list containing both the main
  157. dictionary and the given user word lists. Then you would go on to use .
  158. . .
  159.  
  160. @flushleft(@b(Creating New Dictionaries))
  161.  
  162.     CDICT is the program that takes an alphabetized file of words,
  163. one to a line, and creates a compressed dictionary which MicroSPELL can
  164. use.
  165.  
  166.     @b(CDICT <text dictionary> <compressed dictionary>)
  167.  
  168. @flushleft(@b(Support:))
  169.  
  170.     If you wish to register this program, and be entitled to phone
  171. support, please send $25 to the address given below. If you do not yet
  172. have MicroSPELL 2.0, specify which disk format you would like it sent
  173. on. Currently I can make IBM-PC 5 1/4" and 3 1/2". Other formats can be
  174. made available by special arrangement.
  175.  
  176.     If you make what you think are changes that are useful to many,
  177. send me the updates, and as time permits, I will incorporate the ones I
  178. understand, and agree with into the master sources.  
  179.  
  180. @begin(verbatim)
  181.     USmail:    Daniel Lawrence
  182.         617 New York St
  183.         Lafayette, IN 47901
  184.  
  185.     UUCP:    dynamo.ecn.purdue.edu!mdbs!dan
  186.     ARPA:    mdbs!dan@@dynamo.ecn.purdue.edu
  187.     FIDO:    The Programmer's Room 1:201/10
  188.         (317) 742-5533
  189.     ATT:    (317) 742-5153
  190. @end(verbatim)
  191.